/*
* Copyright (c) 2010-2011 Lockheed Martin Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.eurekastreams.web.client.ui.common.stream;
import java.util.HashMap;
import org.eurekastreams.server.domain.Page;
import org.eurekastreams.server.domain.PagedSet;
import org.eurekastreams.server.domain.stream.ActivityDTO;
import org.eurekastreams.server.domain.stream.StreamScope;
import org.eurekastreams.web.client.events.ChangeActivityModeEvent;
import org.eurekastreams.web.client.events.EventBus;
import org.eurekastreams.web.client.events.MessageStreamAppendEvent;
import org.eurekastreams.web.client.events.MessageStreamUpdateEvent;
import org.eurekastreams.web.client.events.Observer;
import org.eurekastreams.web.client.events.ShowNotificationEvent;
import org.eurekastreams.web.client.events.StreamReinitializeRequestEvent;
import org.eurekastreams.web.client.events.StreamRequestEvent;
import org.eurekastreams.web.client.events.StreamRequestMoreEvent;
import org.eurekastreams.web.client.events.StreamSearchBeginEvent;
import org.eurekastreams.web.client.events.UpdateHistoryEvent;
import org.eurekastreams.web.client.events.UpdatedHistoryParametersEvent;
import org.eurekastreams.web.client.events.data.DeletedActivityResponseEvent;
import org.eurekastreams.web.client.events.data.GotActivityResponseEvent;
import org.eurekastreams.web.client.events.data.GotStreamResponseEvent;
import org.eurekastreams.web.client.history.CreateUrlRequest;
import org.eurekastreams.web.client.model.ActivityModel;
import org.eurekastreams.web.client.model.StreamModel;
import org.eurekastreams.web.client.ui.Session;
import org.eurekastreams.web.client.ui.common.notifier.Notification;
import org.eurekastreams.web.client.ui.common.pagedlist.ItemRenderer;
import org.eurekastreams.web.client.ui.common.stream.renderers.ShowRecipient;
import org.eurekastreams.web.client.ui.common.stream.renderers.StreamMessageItemRenderer;
import org.eurekastreams.web.client.ui.pages.master.StaticResourceBundle;
import com.google.gwt.json.client.JSONArray;
import com.google.gwt.json.client.JSONObject;
import com.google.gwt.json.client.JSONParser;
import com.google.gwt.user.client.Command;
import com.google.gwt.user.client.DeferredCommand;
import com.google.gwt.user.client.ui.FlowPanel;
import com.google.gwt.user.client.ui.Label;
import com.google.gwt.user.client.ui.Panel;
/**
* Page to test advanced search features.
*/
public class StreamPanel extends FlowPanel
{
/**
* ID of last seen activity.
*/
private long lastSeenId = 0L;
/**
* Error label.
*/
private final Label error = new Label("");
/**
* Stream panel.
*/
private StreamListPanel stream = null;
/**
* JSON Query.
*/
private String jsonQuery = "";
/**
* Panel for posting contents.
*/
private final FlowPanel shadowPanel = new FlowPanel();
/**
* The post widget.
*/
private PostToStreamComposite postComposite = null;
/** Textbox widget allowing the user to search. */
private final StreamSearchBoxWidget searchBoxWidget;
/** Widget displaying the current search. */
private final StreamSearchStatusWidget searchStatusWidget;
/** Widget to display the stream title. */
private final StreamTitleWidget streamTitleWidget;
/** Widget to add an activity app to the start page containing the stream. */
private final StreamAddAppWidget addGadgetWidget;
/** Panel showing title and add app link. */
private final FlowPanel titlePanel = new FlowPanel();
/**
* The stream name.
*/
private String streamName = "";
/**
* Posting disabled panel.
*/
private final FlowPanel postingDisabled = new FlowPanel();
/**
* Post content panel.
*/
private final FlowPanel postContent = new FlowPanel();
/**
* Activity Detail Panel.
*/
private final FlowPanel activityDetailPanel = new FlowPanel();
/**
* Activity ID.
*/
private Long activityId = 0L;
/**
* Stream ID.
*/
private Long streamId = 0L;
/**
* Group ID.
*/
private Long groupId = 0L;
/**
* Search string.
*/
private String search = "";
/**
* Sort value.
*/
private String sort = "";
/**
* Sort panel.
*/
private final StreamSortPanel sortPanel = new StreamSortPanel();
/**
* Panel to hold a message when the subject is locked.
*/
private final FlowPanel lockedMessage = new FlowPanel();
/**
* Sort/search row.
*/
private final FlowPanel sortSearchRow = new FlowPanel();
/**
* Feed link widget.
*/
private final StreamFeedLinkWidget feedLinkWidget = new StreamFeedLinkWidget();
/**
* Initialize page.
*
* @param showRecipients
* if recipients should be shown.
* @param itemRenderer
* Renderer for activities.
* @param inPostToStreamComposite
* Stream posting widget to use.
*/
public StreamPanel(final ShowRecipient showRecipients, final ItemRenderer<ActivityDTO> itemRenderer,
final PostToStreamComposite inPostToStreamComposite)
{
this(showRecipients, itemRenderer);
postComposite = inPostToStreamComposite;
setupPostComposite();
}
/**
* Initialize page.
*
* @param showRecipients
* if recipients should be shown.
*/
public StreamPanel(final ShowRecipient showRecipients)
{
this(showRecipients, new StreamMessageItemRenderer(showRecipients));
}
/**
* Initialize page.
*
* @param inShowRecipients
* if recipients should be shown.
* @param itemRenderer
* Renderer for activities.
*/
public StreamPanel(final ShowRecipient inShowRecipients, final ItemRenderer<ActivityDTO> itemRenderer)
{
this.addStyleName(StaticResourceBundle.INSTANCE.coreCss().layoutContainer());
stream = new StreamListPanel(itemRenderer);
stream.addStyleName(StaticResourceBundle.INSTANCE.coreCss().stream());
stream.setVisible(false);
shadowPanel.addStyleName(StaticResourceBundle.INSTANCE.coreCss().postToStreamContainer());
shadowPanel.setVisible(false);
searchBoxWidget = new StreamSearchBoxWidget();
searchStatusWidget = new StreamSearchStatusWidget();
lockedMessage.setVisible(false);
error.setVisible(false);
postContent.add(shadowPanel);
titlePanel.addStyleName(StaticResourceBundle.INSTANCE.coreCss().streamTitlebar());
streamTitleWidget = new StreamTitleWidget();
titlePanel.add(streamTitleWidget);
addGadgetWidget = new StreamAddAppWidget();
titlePanel.add(addGadgetWidget);
sortSearchRow.addStyleName(StaticResourceBundle.INSTANCE.coreCss().navpanel());
sortSearchRow.add(sortPanel);
sortSearchRow.add(feedLinkWidget);
sortSearchRow.add(searchBoxWidget);
this.add(postContent);
this.add(titlePanel);
this.add(searchStatusWidget);
this.add(new UnseenActivityNotificationPanel());
this.add(sortSearchRow);
this.add(error);
this.add(lockedMessage);
this.add(stream);
this.add(activityDetailPanel);
stream.reinitialize();
// ---- Wire up events ----
final EventBus eventBus = Session.getInstance().getEventBus();
eventBus.addObserver(UpdatedHistoryParametersEvent.class, new Observer<UpdatedHistoryParametersEvent>()
{
public void update(final UpdatedHistoryParametersEvent event)
{
checkHistory(event.getParameters());
// Only process this once.
eventBus.removeObserver(UpdatedHistoryParametersEvent.class, this);
}
}, true);
eventBus.addObserver(UpdatedHistoryParametersEvent.class, new Observer<UpdatedHistoryParametersEvent>()
{
public void update(final UpdatedHistoryParametersEvent event)
{
if (checkHistory(event.getParameters()))
{
eventBus.notifyObservers(StreamReinitializeRequestEvent.getEvent());
}
}
});
eventBus.addObserver(GotActivityResponseEvent.class, new Observer<GotActivityResponseEvent>()
{
public void update(final GotActivityResponseEvent event)
{
setSingleActivityMode();
activityDetailPanel.clear();
activityDetailPanel.add(new ActivityDetailPanel(event.getResponse(), inShowRecipients));
}
});
eventBus.addObserver(StreamRequestMoreEvent.class, new Observer<StreamRequestMoreEvent>()
{
public void update(final StreamRequestMoreEvent arg1)
{
JSONObject jsonObj = StreamJsonRequestFactory.getJSONRequest(jsonQuery);
jsonObj = StreamJsonRequestFactory.setMaxId(lastSeenId, jsonObj);
// Must be sorted by date to request more.
jsonObj = StreamJsonRequestFactory.setSort("date", jsonObj);
if (!search.isEmpty())
{
searchBoxWidget.setSearchTerm(search);
searchStatusWidget.setSearchTerm(search);
jsonObj = StreamJsonRequestFactory.setSearchTerm(search, jsonObj);
}
StreamModel.getInstance().fetch(jsonObj.toString(), false);
}
});
eventBus.addObserver(GotStreamResponseEvent.class, new Observer<GotStreamResponseEvent>()
{
public void update(final GotStreamResponseEvent event)
{
PagedSet<ActivityDTO> activity = event.getStream();
int numberOfActivities = activity.getPagedSet().size();
if (numberOfActivities > 0)
{
lastSeenId = activity.getPagedSet().get(numberOfActivities - 1).getId();
}
MessageStreamUpdateEvent updateEvent = new MessageStreamUpdateEvent(activity);
updateEvent.setMoreResults(activity.getTotal() > activity.getPagedSet().size());
error.setText("");
error.setVisible(false);
eventBus.notifyObservers(updateEvent);
stream.setVisible(true);
}
});
eventBus.addObserver(StreamReinitializeRequestEvent.class, new Observer<StreamReinitializeRequestEvent>()
{
public void update(final StreamReinitializeRequestEvent event)
{
eventBus.notifyObservers(new StreamRequestEvent(streamName, jsonQuery, true));
}
});
eventBus.addObserver(MessageStreamAppendEvent.class, new Observer<MessageStreamAppendEvent>()
{
public void update(final MessageStreamAppendEvent evt)
{
if ("date".equals(sortPanel.getSort()))
{
eventBus.notifyObservers(StreamReinitializeRequestEvent.getEvent());
}
else
{
sortPanel.updateSelected("date", true);
}
}
});
eventBus.addObserver(StreamRequestEvent.class, new Observer<StreamRequestEvent>()
{
public void update(final StreamRequestEvent event)
{
if (event.getForceReload() || !event.getJson().equals(jsonQuery))
{
streamName = event.getStreamName();
jsonQuery = event.getJson();
if (activityId != 0L)
{
ActivityModel.getInstance().fetch(activityId, false);
}
else
{
setListMode();
stream.reinitialize();
String titleLinkUrl = null;
String updatedJson = jsonQuery;
JSONObject queryObject = JSONParser.parse(updatedJson).isObject().get("query").isObject();
// Only show cancel option if search is not part of the view.
Boolean canChange = !queryObject.containsKey("keywords");
if (queryObject.containsKey("keywords"))
{
final String streamSearchText = queryObject.get("keywords").isString().stringValue();
searchBoxWidget.setSearchTerm(streamSearchText);
searchStatusWidget.setSearchTerm(streamSearchText);
updatedJson = StreamJsonRequestFactory.setSearchTerm(streamSearchText,
StreamJsonRequestFactory.getJSONRequest(updatedJson)).toString();
}
else if (!search.isEmpty())
{
searchBoxWidget.setSearchTerm(search);
searchStatusWidget.setSearchTerm(search);
updatedJson = StreamJsonRequestFactory.setSearchTerm(search,
StreamJsonRequestFactory.getJSONRequest(updatedJson)).toString();
}
// see if the stream belongs to a group and set up the stream title as a link
else if (queryObject.containsKey("recipient")
&& queryObject.get("recipient").isArray().size() == 1)
{
JSONArray recipientArr = queryObject.get("recipient").isArray();
JSONObject recipientObj = recipientArr.get(0).isObject();
// only show the link if viewing a group stream on the activity page
if ("GROUP".equals(recipientObj.get("type").isString().stringValue())
&& Session.getInstance().getUrlPage() == Page.ACTIVITY)
{
String shortName = recipientObj.get("name").isString().stringValue();
titleLinkUrl = Session.getInstance().generateUrl(
new CreateUrlRequest(Page.GROUPS, shortName));
}
searchBoxWidget.onSearchCanceled();
searchStatusWidget.onSearchCanceled();
}
else
{
searchBoxWidget.onSearchCanceled();
searchStatusWidget.onSearchCanceled();
}
sort = sortPanel.getSort();
updatedJson = StreamJsonRequestFactory.setSort(sort,
StreamJsonRequestFactory.getJSONRequest(updatedJson)).toString();
streamTitleWidget.setStreamTitle(streamName, titleLinkUrl);
addGadgetWidget.setStreamTitle(streamName);
searchBoxWidget.setCanChange(canChange);
searchStatusWidget.setCanChange(canChange);
StreamModel.getInstance().fetch(updatedJson, false);
}
}
}
});
eventBus.addObserver(StreamSearchBeginEvent.class, new Observer<StreamSearchBeginEvent>()
{
public void update(final StreamSearchBeginEvent event)
{
eventBus.notifyObservers(new UpdateHistoryEvent(new CreateUrlRequest("search", event.getSearchText(),
false)));
}
});
eventBus.addObserver(DeletedActivityResponseEvent.class, new Observer<DeletedActivityResponseEvent>()
{
public void update(final DeletedActivityResponseEvent ev)
{
eventBus.notifyObservers(new ShowNotificationEvent(new Notification("Activity has been deleted")));
}
});
}
/**
* Put the widget in list mode.
*/
private void setListMode()
{
titlePanel.setVisible(true);
postContent.setVisible(true);
stream.setVisible(true);
sortPanel.setVisible(true);
searchStatusWidget.setVisible(true);
searchBoxWidget.setVisible(true);
feedLinkWidget.setVisible(true);
sortSearchRow.setVisible(true);
activityDetailPanel.clear();
EventBus.getInstance().notifyObservers(new ChangeActivityModeEvent(false));
}
/**
* Put the widget in single activity mode.
*/
private void setSingleActivityMode()
{
sortPanel.setVisible(false);
titlePanel.setVisible(false);
postContent.setVisible(false);
stream.setVisible(false);
searchStatusWidget.setVisible(false);
searchBoxWidget.setVisible(false);
feedLinkWidget.setVisible(false);
sortSearchRow.setVisible(false);
EventBus.getInstance().notifyObservers(new ChangeActivityModeEvent(true));
}
/**
* Check the history for changes.
*
* @param history
* the history.
* @return true if it has changed.
*/
private Boolean checkHistory(final HashMap<String, String> history)
{
Boolean hasChanged = false;
Long newActivityId = 0L;
Long newStreamId = 0L;
Long newGroupId = 0L;
String newSearch = "";
String newSort = sortPanel.getSort();
if (null != history)
{
if (history.containsKey("activityId"))
{
newActivityId = Long.parseLong(history.get("activityId"));
}
if (history.containsKey("streamId"))
{
newStreamId = Long.parseLong(history.get("streamId"));
}
if (history.containsKey("groupId"))
{
newGroupId = Long.parseLong(history.get("groupId"));
}
if (history.containsKey("search"))
{
newSearch = history.get("search");
}
}
// Only process if the stream/group ID has not changed. Handled elsewhere otherwise.
if (streamId.equals(newStreamId) && groupId.equals(newGroupId))
{
hasChanged = !(newActivityId.equals(activityId) && newSearch.equals(search) && newSort.equals(sort));
}
streamId = newStreamId;
activityId = newActivityId;
search = newSearch;
sort = newSort;
groupId = newGroupId;
return hasChanged;
}
/**
* Sets up the post composite. If the implementation of the minimizer can be built into the constructor of the post
* composite, then this function should be removed.
*/
private void setupPostComposite()
{
shadowPanel.add(postComposite);
DeferredCommand.addCommand(new Command()
{
public void execute()
{
postComposite.setUpMinimizer();
}
});
}
/**
* Set the stream scope to post to.
*
* @param streamScope
* the scope.
* @param postingEnabled
* if posting is enabled.
*/
public void setStreamScope(final StreamScope streamScope, final Boolean postingEnabled)
{
postingDisabled.setVisible(!postingEnabled);
shadowPanel.setVisible(postingEnabled);
if (postComposite == null && postingEnabled)
{
postComposite = new PostToStreamComposite(streamScope);
setupPostComposite();
}
else if (postingEnabled)
{
postComposite.setScope(streamScope);
}
else
{
FlowPanel postingDisabledMessage = new FlowPanel();
postingDisabledMessage.getElement().setInnerHTML("Posting messages has been disabled for this stream.");
postingDisabled.addStyleName(StaticResourceBundle.INSTANCE.coreCss().postingDisabledBox());
postingDisabled.add(postingDisabledMessage);
postContent.add(postingDisabled);
}
}
/**
* Set the locked message panel content.
*
* @param inPanel
* the panel content to set as the locked message.
*/
public void setLockedMessagePanel(final Panel inPanel)
{
lockedMessage.setVisible(true);
lockedMessage.add(inPanel);
}
}